/** 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package it.free.i.virtual.machine.hal.devicealias.echo;

import it.free.i.virtual.machine.hal.devicealias.command.DeviceAliasPortCommand;

/**
 * Feedback payload for actuators' invocation feedbacks
 * @author stefano
 */
public interface ActuatorInvocationFeedBackEcho extends Echo {

	/**
	 * Set the name of the aggregator
	 * @param name is the name of the specific actiator invoked, like brake or throttle
	 */
	public void setInvokedActuatorName(String name);
	
	/**
	 * Set the value sent to the actuator
	 * @param valueWritten is the value sent to the actuator
	 */
	public void setValueWrittenOnActuator(long valueWritten);
	
	/**
	 * Get the name of the aggregator
	 * @return the name of the specific actuator invoked, like brake or throttle
	 */
	public String getInvokedActuatorName();
	
	/**
	 * Get the value sent to the actuator
	 * @return valueWritten to the actuator
	 */
	public long getValueWrittenOnActuator();
	
	/**
	 * @return the actuatorInvocation
	 */
	public DeviceAliasPortCommand getActuatorInvocation();

	/**
	 * @param actuatorInvocation the actuatorInvocation to set
	 */
	public void setActuatorInvocation(DeviceAliasPortCommand actuatorInvocation);
	
}
